home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #2 / Monster Media No. 2 (Monster Media)(1994).ISO / pcboard / fdc_422.zip / FDC-420.DOC < prev    next >
Text File  |  1994-07-06  |  21KB  |  483 lines
  1.  
  2.                         ---------------------------
  3.                            FILE DOWNLOAD COUNTER
  4.                         ---------------------------
  5.                       
  6.                               Version 4.20
  7.  
  8.                               July 6, 1994
  9.  
  10.                                Written by:
  11.                            Brandon M. Bachman
  12.  
  13.                              Distributed By:
  14.  
  15.                             The Salt City BBS
  16.                       801-359-1820 (Intel V.42Bis)
  17.  
  18.                       PCRelay routable -> SALTCITY
  19.                      InterNet: bachman@eng.utah.edu
  20.  
  21.  
  22.              Copyright (c) 1990-94 by Brandon M. Bachman
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  --------------------
  29.    TABLE OF CONTENTS
  30.  --------------------------------------------------------------------------
  31.  
  32.            -----------
  33.              General
  34.            -----------
  35.            Overview ..................................... 1-1
  36.            Program Features ............................. 1-2
  37.            Registrered and Unregistered Versions ........ 1-3
  38.            Why Should I Register? ....................... 1-4
  39.            Disclaimer ................................... 1-5
  40.            License ...................................... 1-6
  41.            System Requirements .......................... 1-7
  42.            Files in the FDC Archive ..................... 1-8
  43.  
  44.            --------
  45.              How?
  46.            --------
  47.            How FDC Operates ............................. 2-1
  48.            Installation ................................. 2-2
  49.            A Configuration File ......................... 2-3
  50.            Starting New with FDC ........................ 2-4
  51.            Removing FDC Entries ......................... 2-5
  52.            Log File ..................................... 2-6
  53.            Word Wrapping ................................ 2-7
  54.            Formats For Recording Download Count ......... 2-8
  55.  
  56.            -----------------
  57.              Configuration
  58.            -----------------
  59.            The Configuration File ....................... 4-1
  60.            Sample Configuration File .................... 4-2
  61.  
  62.            --------
  63.              Why?
  64.            --------
  65.            Operational Details .......................... 5-1
  66.            Examples of Command Line Arguments ........... 5-2
  67.            Common Questions and Answers ................. 5-3
  68.  
  69.            ---------
  70.              What?
  71.            ---------
  72.            Technical Support ............................ 6-1
  73.  
  74.  
  75.  
  76. ------------
  77.   OVERVIEW                                                             1-1
  78. --------------------------------------------------------------------------
  79. FDC will edit the descriptions in PCBoard's DIR files with the number of
  80. times the file has been downloaded from your BBS.
  81.  
  82. FDC makes it easy for you and your users to see instantly which files are
  83. the most popular, and give you an idea of what software you should keep
  84. online or download and which programs are "dead wood" to be removed.
  85.  
  86.  
  87. PROGRAM FEATURES                                                       1-2
  88. --------------------------------------------------------------------------
  89. ■ Automatically finds new downloads since the last date FDC was run.
  90.  
  91. ■ Process any size DOWNLOAD.TXT files. (extremely large)
  92.  
  93. ■ Counts as many as 2 billion downloads of a single file.
  94.  
  95. ■ Auto word wraps the description lines to *any* column you would like
  96.   leaving the "Uploaded by:" line undisturbed with word wrapping.
  97.  
  98. ■ Log file to monitor the program, compatible with PCBoards log file.
  99.  
  100. ■ Designed to run in your nightly event.
  101.  
  102. ■ Popular with users and SysOps as a guide to good programs.
  103.  
  104. ■ Creates a database of all files not found to retry on future runs,
  105.   therefore making the download count 100% accurate.
  106.  
  107. ■ Written in Borland C++ v4.0 for fast compact code.
  108.  
  109.  
  110.  
  111. REGISTERED AND UNREGISTERED VERSIONS                                   1-3
  112. --------------------------------------------------------------------------
  113. "File Download Counter" is not Public Domain or Free ware.  Unregistered
  114. versions are 21 day evaluation copies only, after which they should either
  115. be destroyed or a license agreement purchased.  Registration is only $15 so
  116. please register your copy today.  Read 'REGISTER.DOC' included with this
  117. archive for more information.
  118.  
  119.  
  120.  
  121. WHY SHOULD I REGISTER?                                                 1-4
  122. --------------------------------------------------------------------------
  123. ■ Unregistered versions only count up to 25 downloads in the DIR files
  124.   Registered versions will continue to count as high as 2 million.
  125.  
  126. ■ Free technical support via the Salt City BBS.
  127.  
  128. ■ Lifetime free updates of all future versions guaranteed.
  129.  
  130. ■ Help support future updates and development of FDC.
  131.  
  132. ■ Support the shareware concept.
  133.  
  134.  
  135.  
  136. DISCLAIMER                                                             1-5
  137. --------------------------------------------------------------------------
  138. The authors make no warranties or representation of any kind, expressed or
  139. implied, with respect to "File Download Counter", or its quality,
  140. reliability, or performance, or its merchantability or fitness for any
  141. purpose.  The user assumes the entire risk as to the quality, performance
  142. and reliability of the software and documentation.
  143.  
  144.  
  145.  
  146. LICENSE                                                                1-6
  147. --------------------------------------------------------------------------
  148. The "File Download Counter" ("The Software") is COPYRIGHT 1990-94 by
  149. Brandon M. Bachman, ALL RIGHTS RESERVED WORLDWIDE.
  150.  
  151. A license grants you a nonexclusive, nontransferable license to use
  152. "File Download Counter" software on a single central processing unit at any
  153. one time.
  154.  
  155. You may NOT engage in, nor permit third parties to engage in, any of the
  156. following :
  157.  
  158.         A)  Sell, rent, sub-license, lease, or grant other rights
  159.             of this software to others.
  160.  
  161.         B)  Attempt to disassemble, decompile, or reverse engineer
  162.             the software or the files it generates in any way.
  163.  
  164.         C)  Make alterations of any kind in the files of this
  165.             software, except as noted below.
  166.  
  167.         D)  Collect fees for distribution of the software.
  168.  
  169. The authors of the software grant you a license to use this software as
  170. long as you meet the above conditions.  Any violation of the above
  171. conditions will result in the termination of your license to use this
  172. software.  Upon termination of this license for any reason, you must
  173. stop using the software and destroy all copies of it in your possession
  174. immediately.
  175.  
  176. The author(s) of this software are not liable for damages suffered as a
  177. result of the improper use, proper use, or inability to use this
  178. software.  This type of disclaimer is prohibited by law in some states,
  179. and is therefore void in those states.
  180.  
  181.  
  182.  
  183. SYSTEM REQUIREMENTS                                                    1-7
  184. --------------------------------------------------------------------------
  185. To run "File Download Counter" you will need the following:
  186.  
  187. 1.  IBM PC/XT/AT, PS/2 or 100% compatible machine.
  188. 2.  Color or Monochrome Graphics adapter.
  189. 3.  MS-DOS 5.0 or higher.
  190. 4.  PCBoard BBS Software.
  191.  
  192.  
  193.  
  194. FILES IN THIS ARCHIVE                                                  1-8
  195. --------------------------------------------------------------------------
  196. "File Download Counter" is distributed as a archival file "FDC-XXX.ZIP"
  197. You must have PkZip v2.04g or later to extract the files listed below.
  198. PkZip v2.04g is Shareware and is available on many computer bulletin boards.
  199. Files in the archive include:
  200.  
  201.        FDC.EXE      -  The "File Download Counter" program.
  202.        SAMPLE.CFG   -  Sample configuration file.
  203.        FDC-420.DOC  -  This documentation file.
  204.        REGISTER.DOC -  Information on registering your copy.
  205.        README.DOC   -  Important information for new and old users.
  206.        COMMENTS.DOC -  List of comments from other users of FDC.
  207.  
  208. Sysops are free to distribute uregistered versions of FDC as a complete
  209. unaltered archive only.
  210.  
  211.  
  212.  
  213. HOW FDC OPERATES                                                       2-1
  214. --------------------------------------------------------------------------
  215. FDC will read the DOWNLOAD.TXT file created by PCBoard, and count all
  216. recently downloaded files since the last time File Download Counter was
  217. executed successfully.  It then searches your PCBoard DIR files for a match.
  218. Upon finding a match in your PCBoard DIR files FDC inserts the number of
  219. times the file has been downloaded with the file description in your PCBoard
  220. DIR file.
  221.  
  222. There are 3 styles of editing your PCBoard DIR files that FDC supports.
  223. They are outlined below with samples of each style.  You may choose the
  224. style you would like FDC to use by changing the STYLE= parameter in the
  225. configuration file.
  226.  
  227.  
  228. Sample of Style #1 and #2
  229. -------------------------
  230. FILENAME.ARC   35252  06-27-90  <23> This is the description of the file.
  231. FILE-TWO.ZIP  213445  06-23-88  <11> This is another description.
  232. NEXTFILE.ZIP  243536  06-21-90  <14> This one has been downloaded 14 times,
  233.                               | and the description is auto word-wrapped.
  234. FILEFOUR.LZH  246246  05-12-90  <13> File Four v3.3, description.  With
  235.                               | this entry word wrapped, the "Uploaded by:"
  236.                               | line is not disturbed.
  237.                               | Uploaded by: Brandon Bachman
  238.  
  239. The only difference between Style #1 & #2 is that Style #2 will
  240. truncate the first line of the description after it inserts <##>.
  241. Style #1 will word wrap long descriptions to the next line.
  242.  
  243.  
  244. Sample of Style #3
  245. ------------------
  246. FILENAME.ARC   35252  06-27-90  This is the description of the file.
  247.                               | Downloaded 23 times.
  248. FILE-TWO.ZIP  213445  06-23-88  This is another description.
  249.                               | Downloaded 12 times.
  250. NEXTFILE.ZIP  243536  06-21-90  This one has been downloaded 14 times,
  251.                               | and the description is auto word wrapped.
  252.                               | Downloaded 1234 times.
  253. FILEFOUR.LZH  246246  05-12-90  File Four v3.3, description.  With
  254.                               | this entry word wrapped, the "Uploaded by:"
  255.                               | Uploaded by: Brandon M. Bachman
  256.                               | Downloaded 233 times.
  257.  
  258. Style #3 inserts an additional line to each file description.  You can
  259. customize this line by editing the TEXT= option in the configuration
  260. file.
  261.  
  262.  
  263.  
  264. INSTALLATION                                                           2-2
  265. --------------------------------------------------------------------------
  266. To install "File Download Counter" you must have the PKZip program
  267. available, then create a sub-directory for "File Download Counter" on your
  268. hard disk.  Enter the sub-directory and un-Zip the files.  Here is an
  269. example of how you might do this:
  270.  
  271.  
  272.            E:                     (Go to E: drive)
  273.            CD\                    (Go to the root directory)
  274.            MD FDC                 (Create E:\FDC sub-directory)
  275.            CD FDC                 (Go into the E:\FDC sub-directory)
  276.            COPY A:\FDC-420.ZIP    (Copy the program from drive A:)
  277.            PKUNZIP FDC-420.ZIP    (UnZip the program into the directory)
  278.  
  279.  
  280.  
  281. CONFIGURATION FILE                                                     2-3
  282. --------------------------------------------------------------------------
  283. After you complete the installation you must then edit the FDC.CFG file
  284. included in this archive to your needs.  Read the  "Sample Configuration
  285. File" and "Operational Details" sections below for instructions.
  286.  
  287.  
  288.  
  289. STARTING THE DOWNLOAD COUNT                                            2-4
  290. --------------------------------------------------------------------------
  291. First time users should initialize FDC by making sure the LAST_RUN_DATE=
  292. configuration option is a date in history older than first download from
  293. your BBS.  In others if your BBS has been online for 10 years make sure
  294. the LAST_RUN_DATE is set back to at least 1984 the first time you run
  295. FDC.  This ensures that downloads prior to the current date are counted
  296. the first time.
  297.  
  298.  
  299.  
  300. STRIPPING FDC ENTRIES FROM PCBOARD DIR FILES                           2-5
  301. --------------------------------------------------------------------------
  302. If you would like to remove all entries made by FDC in your PCBoard DIR
  303. files you may do so by using the /STRIP command line argument.  At DOS
  304. this command would be "FDC /STRIP"  This is useful if you decide to switch
  305. from one style of editing your DIR files to another.
  306. (ie., STYLE=1 and you would like STYLE=3).
  307.  
  308. Note: Once you have STRIPed entries made by FDC from your PCBoard DIR
  309. files you will want to reset the LAST_RUN_DATE= in your configuration
  310. file to be a date earlier than the first download from your BBS.  See
  311. section 2-4 above for more information.
  312.  
  313.  
  314.  
  315. LOG FILE                                                               2-6
  316. --------------------------------------------------------------------------
  317. To create a log file of all FDC's activities use the argument LOG= in your
  318. configuration file.  This is the complete path and file name of the LOG file.
  319. The format of the LOG file is compatible with PCBoard CALLER log.  This way
  320. you can specify the LOG file as the CALLER log created by PCBoard.  Doing so
  321. will help cut down on many logs files clogging up your systems.
  322.  
  323.  
  324. WORD WRAPPING                                                          2-7
  325. --------------------------------------------------------------------------
  326. Word Wrapping only applies if you have STYLE=1 or STYLE=2 in your
  327. configuration file.  (Word Wrapping is not an option on STYLE=3).
  328.  
  329. FDC handles word wrapping in two ways.  If a file description requires
  330. word wrapping, FDC first searches for the "|" character in the secondary
  331. line of your file description, and when found will word wrap to the space
  332. following the "|" character.  However some sysops like to have all their
  333. secondary lines of the descriptions lined up on columns other than the
  334. default of the 32nd column by PCBoard.  You can change the default by
  335. using the argument CHAR=xx, where xx is the column or number of characters
  336. to word wrap to.
  337.  
  338. FDC will not edit the "Uploaded by:" line when word wrapping.
  339.  
  340.  
  341.  
  342. THREE FORMATS FOR RECORDING DOWNLOAD COUNT                             2-8
  343. --------------------------------------------------------------------------
  344. FDC supports three different formats for recording the number of times
  345. a file has been downloaded.  The first is the default which will put
  346. <##> in the first few characters of the first line of the files description
  347. in the DIR file.  The second will do the same as the first, however it will
  348. not word wrap but truncate all descriptions which exceed 79 characters.
  349. The third will insert a separate line at the end of the secondary lines of
  350. the description but before the "Uploaded by:"  This line will look like
  351. this:
  352.                    "| Downloaded 45 times."
  353.  
  354. If you perfer a differnet wording you may change the format to anyway
  355. you would like to editing the TEXT= parameter in the .CFG file.
  356.  
  357. By default FDC will insert this line starting at the 32nd column, however
  358. if you would like it to be inserted at another column simply use the
  359. CHAR=xx option specified section 2.9.
  360.  
  361. To implement one of the various format of recording the number of times
  362. downloaded use the STYLE=x option, where x is the number of the style you
  363. would like.
  364.  
  365. For samples of the 3 different styles please see section 2-1 above.
  366.  
  367.  
  368.  
  369. CONFIGURATION FILE                                                     4-1
  370. --------------------------------------------------------------------------
  371. FDC daily operations are determined by the way you setup the FDC.CFG file.
  372. The configuration file must be called 'FDC.CFG' and be in the directory
  373. from which you run FDC.EXE.  It is critical that you take care in setting
  374. up this file, instructions for doing so are found in the "Sample
  375. Configuration File" section below and the above sections.
  376.  
  377. If you wish to have mulitple configuration files you may use the /CFG=
  378. command line argument.  If you wanted to use the configuration file
  379. FDC-01.CFG you would execute FDC with the command line "FDC /CFG=FDC-01"
  380. FDC will automatically apend the .CFG, .P and .T to the file names for the
  381. configuration file and data files.
  382.  
  383.  
  384.  
  385. SAMPLE CONFIGURATION FILE                                              4-2
  386. --------------------------------------------------------------------------
  387. Please refer to the SAMPLE.CFG file for a sample confgiuration file.
  388.  
  389. You may use any standard ASCII text editor to edit the SAMPLE.CFG file
  390. found in this archive, or to create your own.
  391.  
  392. Change the data in the SAMPLE.CFG to your needs and then rename
  393. SAMPLE.CFG to FDC.CFG
  394.  
  395.  
  396.  
  397. OPERATIONAL DETAILS                                                    5-1
  398. --------------------------------------------------------------------------
  399. After you have your FDC.CFG edited to your needs then type "FDC" and watch
  400. the wiz-bangs fly!  FDC will let you know if your FDC.CFG file may have
  401. errors.
  402.  
  403. NOTE: If it is the first time you have run FDC see "Starting the Download
  404. Count" above (section 2-4) for more information.
  405.  
  406. To update your recent downloads every day, put FDC in your EVENT.SYS
  407. file.  FDC is designed to run in your nightly event.  If there is an error,
  408. FDC will sound a beep, record the error in the LOG= file, pause 10 seconds
  409. and then exit.
  410.  
  411.  
  412.  
  413. EXAMPLES OF COMMAND LINE ARGUMENTS TO RUN FDC, AND THE RESULTS         5-2
  414. --------------------------------------------------------------------------
  415.  
  416.     1.  FDC
  417.  
  418.         This runs FDC using settings in the FDC.CFG file.  This is
  419.         the most common way to run FDC.
  420.  
  421.  
  422.     3.    FDC /STRIP
  423.  
  424.     This will run FDC and have it strip out all entries in your DIR
  425.     files that FDC made.  This is useful if you need to start the
  426.     the count over for FDC.
  427.  
  428.     4.  FDC /CFG=FDC-02
  429.  
  430.         This will run FDC using the FDC-02.CFG, and FDC-02.T filenames
  431.         for the configuration file, and the data files respectfully.
  432.  
  433.  
  434.  
  435. COMMON QUESTIONS & ANSWERS                                             5-3
  436. --------------------------------------------------------------------------
  437. Q.  I am a new user with File Download Counter and I it is not counting
  438.     any downloads from the PCBoard DOWNLOAD.TXT file.
  439.  
  440. A.  Make sure when you first run FDC to set the LAST_RUN_DATE= in the
  441.     configuration file.  See secction 2-4 "Starting a New Count" above.
  442.  
  443. Q.  When I register FDC will I need to call your BBS to obtain future
  444.     registered updates, and will there be a fee for upgrading.
  445.  
  446. A.  FDC is self registering for all future versions, you can simply
  447.     download a copy from a distributor BBS.  There is and never will be
  448.     and additional fee for upgrading FDC even if prices do increase,
  449.     once you have are a registered user you may upgrade for free.
  450.  
  451.  
  452.  
  453. TECHNICAL SUPPORT                                                      6-1
  454. --------------------------------------------------------------------------
  455. The latest version of "File Download Counter" software and technical
  456. support are available from:
  457.  
  458.   The Salt City BBS                  Join the Support (1) Conference
  459.   801-359-1820 (Intel V.42Bis)       to download the newest versions, ask
  460.   PCRelay routable -> SALTCITY       questions, and offer suggestions.
  461.  
  462. Or write to:  Brandon M. Bachman
  463.               261 S. 800 E. #10
  464.               Salt Lake City, Utah 84102
  465.  
  466. Or InterNet:  bachman@eng.utah.edu
  467.  
  468.  
  469.    ---------------------------------------------------------------
  470. *** IF YOU HAVE NOT READ A WORD OF THIS DOC FILE PLEASE READ THIS ***
  471.    ---------------------------------------------------------------
  472.  
  473. For INSTANT access on the Salt City BBS type "ACCESS" at the MainBoard
  474. Command Prompt.  (it will not be on the menu)   Then when prompted
  475. type in the code "FDC".  Your security level will automatically be
  476. upgraded and you will also be registered for the Support (1) Conference.
  477.  
  478. Then, you can flag the newset version of FDC for download by typing "FDC"
  479. at the MainBoard Prompt.  Then type "D" to download the file.
  480.  
  481. Please leave all messages regarding FDC in ONLY the Support (1) Conference.
  482.  
  483.